Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(sp1-build): default docker tag #1693

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

fix(sp1-build): default docker tag #1693

wants to merge 14 commits into from

Conversation

ratankaliani
Copy link
Member

@ratankaliani ratankaliani commented Oct 24, 2024 •
edited
Loading

Overview

The default Docker tag for SP1 was incorrectly set to latest, which caused issues due to caching. The latest tag doesn’t guarantee users will get the most up-to-date container, as their Docker daemon may use a cached version. This caused problems, like outdated dependencies, such as the Rust toolchain (v1.75).

Fixes

  • Create SP1_CIRCUIT_VERSION str file. Whenever we do a new release, SP1_CIRCUIT_VERSION should be updated.
  • Fix the documentation to point to SP1 3.0.0 rather than 2.0.0.

Source

I detected this issue because the Rust toolchain version inside of this container was quite outdated (1.75), so some of my dependencies were failing to build because of their MSRV.

Every time we push to main, this workflow releases a tag called main, as well as a release for the corresponding version tag.

sp1/.github/workflows/docker-publish.yml

Lines 64 to 76 in 4cac73b

- name: Finalize Docker Metadata
id: docker_tagging
run: |
if [[ "${{ github.event_name }}" == 'schedule' ]]; then
echo "cron trigger, assigning nightly tag"
echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:nightly-${GITHUB_SHA}" >> $GITHUB_OUTPUT
elif [[ "${GITHUB_REF##*/}" == "main" ]] || [[ ${GITHUB_REF##*/} == "master" ]]; then
echo "manual trigger from master/main branch, assigning latest tag"
echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${GITHUB_REF##*/},${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest" >> $GITHUB_OUTPUT
else
echo "Neither scheduled nor manual release from main branch. Just tagging as branch name"
echo "docker_tags=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${GITHUB_REF##*/}" >> $GITHUB_OUTPUT
fi

@ratankaliani ratankaliani changed the title fix: default tag fix(sp1-build): default docker tag Oct 24, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 24, 2024 •
edited
Loading

SP1 Performance Test Results

Branch: ratan/fix-default-docker-tag
Commit: 1cc09011
Author: ratankaliani

program cycles execute (mHz) core (kHZ) compress (KHz) time success
fibonacci 11291 0.16 2.82 0.46 25s ✅
ssz-withdrawals 2757356 10.33 116.77 38.53 1m12s ✅
tendermint 12593597 5.32 239.43 106.39 2m1s ✅

@ratankaliani ratankaliani force-pushed the ratan/fix-default-docker-tag branch from 5b4b5d2 to 2722e26 Compare October 30, 2024 18:51
@ratankaliani ratankaliani changed the base branch from dev to main October 30, 2024 18:51
@nhtyy nhtyy added the maybe-stale A pr or issue that hasnt seen alot of activity recently label Nov 20, 2024
@nhtyy nhtyy added docker Pull requests that update Docker code next-release A PR or an issue that should resolved before the next major release labels Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docker Pull requests that update Docker code maybe-stale A pr or issue that hasnt seen alot of activity recently next-release A PR or an issue that should resolved before the next major release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ratankaliani @nhtyy @mattstam @sinasab